Migrate a Bid Model
Overview
The Definitions and API Comparison tables highlight the shared terminology, actions and API methods between IQM and Beeswax for creating and managing Bid Modeling. Select an endpoint to review each platform's relevant API documentation. By comparing APIs, you can migrate your workflow from Beeswax to IQM.
For a comprehensive overview of IQM's Bid Model services, see the Bid Model API.
Definitions
| IQM | Beeswax | Description |
|---|---|---|
| Bid Model | Bid Model | The set of optimizations applied to a Campaign or Insertion Order. These optimizations control where ads appear, manage priorities, and dimensions. |
| Bid Model Data | Terms | A Bid Model setting that adjusts a Campaign's base bid based on specified parameters. |
| Dimension | Targeting Key | A property in digital advertising used to categorize, filter, or analyze Audiences, Campaigns or Inventories. Serves as a targeting parameter for Advertisers, specifying where an ad appears. |
| Bid Modifier | Bid Modifier | A multiplier applied to a base bid. |
| Spend Ratio | Delivery Modifiers | A setting that determines how the Campaign budget is distributed across targeting dimensions. |
| Dimension Priority | Weight | A setting that dictates the order in which a Campaign should attempt to deliver impressions based on the available budget. |
IQM's Bid Model currently supports applying bid modifiers to the following dimensions:
- Creative: Creative ID
- Location: State, City, Zip Code
- Inventory: Open Exchange, Publisher Category*, Deal ID**
*Spend Ratios are not supported for the Publisher Category dimension subcategory. Refer to Spend Ratio Overview Help Center article for more information.
**Bid Modifiers are not supported for the Deal ID dimension subcategory. Refer to the Bid Modifier Overview Help Center Article for more information.
API Comparison
IQM: https://app.iqm.com
Beeswax: https://{buzz_key}.api.beeswax.com
| Action | IQM Endpoint | Beeswax Endpoint | Notes |
|---|---|---|---|
| Add Bid Modeling | /api/v3/bm/campaigns/{campaignId}/bid-models | /rest/v2/bid-modifiers | |
| Add Bid Modeling to Insertion Order/Campaign | /api/v3/bm/io/{ioId}/bid-models | /rest/v2/campaigns /rest/v2/line-items | Add Bid Modeling to an Insertion Order and its associated Campaigns. Beeswax endpoints use the bid_modifier_id parameter when creating/updating a Campaign or Line Item to add a bid modifier. |
| Update Bid Modeling | /api/v3/bm/campaigns/{campaignId}/bid-models | /rest/v2/campaigns/{id} /rest/v2/line-items/{id} | |
| Add/Update Multiple Bid Models | /api/v3/bm/campaigns/{campaignId}/bid-models | /rest/v2/campaigns/bulk /rest/v2/line-items/bulk | IQM endpoint supports adding, updating, and deleting Bid Model data. |
| Get Bid Model Details | /api/v3/bm/campaigns/{campaignId}/dimensions/count /api/v3/bm/campaigns/{campaignId}/dimension/{dimensionId}/spent /api/v3/bm/campaigns/{campaignId}/bid-models/count | /rest/v2/ref/bid-models /rest/v2/bid-modifiers /rest/v2/bid-modifiers/{id} /rest/v2/bid-modifiers/{id}/campaigns /rest/v2/bid-modifiers/{id}/line-items | IQM endpoints get counts of dimensions, spending by dimension, and modeled items count by campaignId.Beeswax endpoints get lists of Bid Models, bid modifiers, and lists of Campaigns and Line items by bid modifier ID. |
| Include/Exclude Management | /api/v2/cmp/deviceType/includeExclude /api/v2/cmp/exchange/includeExclude /api/v2/cmp/trafficsource/includeExclude /api/v3/bm/campaigns/{campaignId}/include-Exclude/dimensions/{dimensionId} | /rest/v2/bid-modifiers /rest/v2/bid-modifiers/{id} /rest/v2/bid-modifiers/{id} | IQM has separate endpoints for including/excluding device types, exchanges, traffic sources, and dimensions. Beeswax specifies include/exclude options with the targeting_key parameter when creating/updating a Bid Modifier. |
More Bid Model Resources
IQM:
Beeswax: